package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.ApplyToProgDepAddDTO;
import org.jsola.hr.dto.ApplyToProgDepUpdateDTO;
import org.jsola.hr.query.ApplyToProgDepQuery;
import org.jsola.hr.vo.ApplyToProgDepListVO;
import org.jsola.hr.vo.ApplyToProgDepVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-方案适用设置部门")
public interface IApplyToProgDepControllerAPI {

    /**
     * 新增方案适用设置部门
     * @param applyToProgDepAddDTO 方案适用设置部门新增实体
     * @return 方案适用设置部门展示对象
     */
    @ApiOperation(value = "新增方案适用设置部门")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgDepAddDTO", dataType = "ApplyToProgDepAddDTO", value = "新增方案适用设置部门", paramType = "body")
    })
    Result<ApplyToProgDepVO> save(ApplyToProgDepAddDTO applyToProgDepAddDTO);


    /**
     * 修改方案适用设置部门
     * @param applyToProgDepUpdateDTO 方案适用设置部门
     * @return 更新数量
     */
    @ApiOperation(value = "修改方案适用设置部门")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgDepUpdateDTO", dataType = "ApplyToProgDepUpdateDTO", value = "修改方案适用设置部门", paramType = "body")
    })
    Result<Integer> update(ApplyToProgDepUpdateDTO applyToProgDepUpdateDTO);




    /**
     * 删除单个方案适用设置部门，彻底删除
     * @param applyToProgDepId 方案适用设置部门id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个方案适用设置部门，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgDepId", dataType = "String", value = "方案适用设置部门id", paramType = "path")
    })
    Result<Integer> delete(String applyToProgDepId);


    /**
     * 批量删除方案适用设置部门，彻底删除
     * @param applyToProgDepIds 方案适用设置部门id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除方案适用设置部门，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgDepIds", dataType = "String[]", value = "方案适用设置部门id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] applyToProgDepIds);


    /**
     * 根据方案适用设置部门id查询方案适用设置部门详情
     * @param applyToProgDepId 方案适用设置部门id
     * @return 方案适用设置部门详情
     */
    @ApiOperation(value="根据方案适用设置部门id查询方案适用设置部门详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgDepId", dataType = "String", value = "方案适用设置部门id", paramType = "path")
    })
    Result<ApplyToProgDepVO> findById(String applyToProgDepId);


    /**
     * 查询方案适用设置部门
     * @param applyToProgDepQuery 方案适用设置部门查询参数
     * @return page
     */
    @ApiOperation(value="查询方案适用设置部门")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgDepQuery", dataType = "ApplyToProgDepQuery", value = "方案适用设置部门查询参数", paramType = "query")
    })
    Result<List<ApplyToProgDepListVO>> listAll(ApplyToProgDepQuery applyToProgDepQuery);


     /**
     * 分页查询方案适用设置部门
     * @param applyToProgDepQuery 方案适用设置部门查询参数
     * @return page
     */
    @ApiOperation(value="分页查询方案适用设置部门")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgDepQuery", dataType = "ApplyToProgDepQuery", value = "方案适用设置部门查询参数", paramType = "query")
    })
    Result<Page<ApplyToProgDepListVO>> page(ApplyToProgDepQuery applyToProgDepQuery);


}

